Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: add new page to document s3proxy #2417

Merged
merged 11 commits into from
Oct 10, 2023
Merged

docs: add new page to document s3proxy #2417

merged 11 commits into from
Oct 10, 2023

Conversation

derpsteb
Copy link
Member

@derpsteb derpsteb commented Oct 6, 2023

Context

s3proxy is now merged to main. This PR adds user-facing docs for deployment, background information and the example application Filestash.

Proposed change(s)

  • Add user-facing docs for s3proxy. Includes link to instructions for example application.

Checklist

  • Update docs
  • Add labels (e.g., for changelog category)
  • Is PR title adequate for changelog?
  • Link to Milestone

@derpsteb derpsteb added the documentation Improvements or additions to documentation label Oct 6, 2023
@derpsteb derpsteb added this to the v2.12.0 milestone Oct 6, 2023
@derpsteb derpsteb requested a review from m1ghtym0 October 6, 2023 10:03
@derpsteb derpsteb requested a review from thomasten as a code owner October 6, 2023 10:03
@netlify
Copy link

netlify bot commented Oct 6, 2023

Deploy Preview for constellation-docs ready!

Name Link
🔨 Latest commit 1d456c8
🔍 Latest deploy log https://app.netlify.com/sites/constellation-docs/deploys/652550c6323e460007d0ca02
😎 Deploy Preview https://deploy-preview-2417--constellation-docs.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

docs/docs/workflows/s3proxy.md Outdated Show resolved Hide resolved
docs/docs/workflows/s3proxy.md Outdated Show resolved Hide resolved
docs/docs/workflows/s3proxy.md Outdated Show resolved Hide resolved
Copy link
Member

@m1ghtym0 m1ghtym0 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We should rewrite the encrypted persistent storage page: https://docs.edgeless.systems/constellation/architecture/encrypted-storage
Make it a bit more generic and add the concept of the S3 proxy.
We can do that in a separate PR though.

docs/docs/getting-started/examples/filstash-s3proxy.md Outdated Show resolved Hide resolved
docs/docs/workflows/s3proxy.md Outdated Show resolved Hide resolved
docs/docs/workflows/s3proxy.md Outdated Show resolved Hide resolved
docs/docs/workflows/s3proxy.md Show resolved Hide resolved
docs/docs/workflows/s3proxy.md Outdated Show resolved Hide resolved
docs/docs/workflows/s3proxy.md Outdated Show resolved Hide resolved
docs/docs/getting-started/examples/filstash-s3proxy.md Outdated Show resolved Hide resolved
@derpsteb derpsteb mentioned this pull request Oct 9, 2023
3 tasks
@derpsteb
Copy link
Member Author

derpsteb commented Oct 9, 2023

I've added a short section to the encrypted storage page that mentions s3proxy. We should probably sit together to restructure the page, so leaving that open for the moment.

docs/docs/architecture/encrypted-storage.md Outdated Show resolved Hide resolved
docs/docs/architecture/encrypted-storage.md Outdated Show resolved Hide resolved
docs/docs/architecture/encrypted-storage.md Outdated Show resolved Hide resolved
docs/docs/architecture/encrypted-storage.md Outdated Show resolved Hide resolved
docs/docs/workflows/s3proxy.md Outdated Show resolved Hide resolved
docs/docs/workflows/s3proxy.md Outdated Show resolved Hide resolved
docs/docs/workflows/s3proxy.md Outdated Show resolved Hide resolved
docs/docs/workflows/s3proxy.md Outdated Show resolved Hide resolved
docs/docs/workflows/s3proxy.md Outdated Show resolved Hide resolved
docs/docs/workflows/s3proxy.md Outdated Show resolved Hide resolved
Co-authored-by: Thomas Tendyck <[email protected]>
@derpsteb derpsteb requested a review from thomasten October 10, 2023 07:04
@malt3 malt3 mentioned this pull request Oct 10, 2023
docs/docs/architecture/encrypted-storage.md Outdated Show resolved Hide resolved
docs/docs/workflows/s3proxy.md Outdated Show resolved Hide resolved
docs/docs/workflows/s3proxy.md Outdated Show resolved Hide resolved
docs/docs/workflows/s3proxy.md Outdated Show resolved Hide resolved
@derpsteb derpsteb merged commit 4ef2e28 into main Oct 10, 2023
6 checks passed
@derpsteb derpsteb deleted the feat/s3proxy/docs branch October 10, 2023 13:35
@derpsteb derpsteb changed the title s3proxy: add new page to documentation docs: add new page to document s3proxy Nov 15, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants